Formal Parameter | Type | Default | Required | Description |
appliesTo | STRING | false | This parameter informs the javascript the id of the bone the actions of this component applies to. For example, action of a Toolbar will be applied to the "grid" bone (in the Report page), or the the rwb_viewer (in the document's page). Possible values for this property are bone ids, its usage depends on the page. |
|
blockCount | INTEGER | 5 | false | Specifies the number of prompts are displayed per block in report page. Only applies when there are multiple prompts defined in given report and when display mode is set to display all prompts in one page. It indicates the number of prompts per block being displayed in page. This flag is used as int value. |
canCancelPrompt | BOOLEAN | true | false | Indicates whether the cancel prompt button is displayed |
contextMenus | STRING | false | This formal parameter is used by the Transform to identify the context-menus definition. The value of this parameter can specify either:
|
|
cssPrefix | STRING | false | Prefix to append to all css class names. |
|
debugErrorFlags | INTEGER | 65535 | false | Indicates which extra debug information to include in case of an error. The flags are taken from the EnumWebAppDebugFlags enumeration. |
debugFlags | INTEGER | 0 | false | Indicates which debug information to include. The flags are taken from the EnumWebAppDebugFlags enumeration. |
displayMode | INTEGER | 1 | false | Specifies how multiple prompts will be displayed in report layout. This only applies when there are multiple prompts defined in given report. Prompts can be shown all or, one by one. This flag is used as int value. Allowed Values:
|
dragMode | INTEGER | 0 | false | Indicates the drag mode that the component to render will have. Usage: This tells us if the dialog can be dragged or docked (or both). Possible values for this property and their meaning include: |
executeButtonLabel | STRING | false | Specifies the ID of the descriptor to use on the button for continue with document processing.
The id should be a valid ID in the Resources Bundle. The default value is empty, in which case the Transform will use a predetermined value (which might be different between reports and documents). The string value for the formal parameter takes the form mstrWeb.3649 |
|
exportDocumentLabel | INTEGER | 925 | false | Deprecated. FP not being used anymore. In its place, you might use executeButtonLabel. Specifies the ID of the descriptor to use on the button for continue with document processing. Default value is for displaying 'Execute Document'. This flag is used as string value. |
exportReportLabel | INTEGER | 539 | false | Deprecated. FP not being used anymore. In its place, you might use executeButtonLabel. Specifies the ID of the descriptor to use on the button for continue with report processing. Default value is for displaying 'Execute Report'. This flag is used as string value. |
extraInput | STRING | false | Indicates any extra inputs to be included in the forms generated by the transform. |
|
extraUrl | STRING | false | Indicates any extra parameters to be included in the links generated by the transform. |
|
firstIncFecthImage | STRING | arrow_first_inc_fetch_v.gif | false | Deprecated. FP not being used anymore. The name of the image for the first block in incremental fetching. |
formID | STRING | PromptForm | false | Specifies the name and Id of the HTML form tag in report page. All prompts are part of one HTML form, which is submitted as request in order to be processed. This form has a unique name and id for indentifying it when prompt answers are processed. This value is also referenced from the Javascript files This flag is used as text value. |
globalCssErrorMessage | STRING | error-message | false | Deprecated. The css class to use for the title cannot be controlled by a Formal Parameter anymore. CSS to be used in all error messages. |
globalCssErrorTitle | STRING | error-title | false | Deprecated. The css class to use for the title cannot be controlled by a Formal Parameter anymore. CSS to be used in all Error titles. |
height | STRING | false | Indicates the default height of the component. If this is not a resizable component, this
is the height used. If if it resizable, though, the user might change its width
using javascript and the value is saved in a preference; thereafter the Transform
will use this new value for this component. |
|
iframeEnabled | BOOLEAN | false | false | Indicates whether the transform supports iframe manipulations. |
imgWait | STRING | ani_wait.gif | false | Deprecated. This value is not used anymore by the Transform as the wait image is included using css. Name of the image for the Processing icon on the Wait page. Allowed Values: The value to indicate should be a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter. |
incrementalAttrElemBlockCount | INTEGER | 30 | false | Specifies the maximum number of attribute elements to be displayed in available list when incremental fetch is available. Only applies in Element prompts. Prompt styles, such as list and radio button, are governed by this flag, even though they don't provide any incremental fetch functionality. This value is ignored by other prompt types and it gets by a Web preference end-user can edit. This value is propagated to corresponding prompt transform(s), meaning that will affect all prompts in a given report. This flag is used as int value. For more detailed information, please refer to Web preferences documentation. See Project defaults/General section, at Incremental fetch preference: "Maximum number of report objects per block". |
incrementalObjectsBlockCount | INTEGER | 30 | false | Specifies the maximum number of objects (attributes, attribute forms and metrics) to be displayed in available list
when incremental fetch is available. Only applies in Object and Expression prompts. Prompt styles, such as list and radio button, are governed by this flag, even though they don't provide any incremental fetch functionality. This value is ignored by other prompt types and it gets set by a Web preference end-user can edit. This value is propagated to corresponding prompt transform(s), meaning that will affect all prompts in a given report. This flag is used as int value. For more detailed information, please refer to Web preferences documentation. See Project defaults/General section, at Incremental fetch preference: "Maximum number of attributes per block". |
indexContentPostfixImage | STRING | _olive.gif | false | Deprecated. FP not being used anymore. The name of each image on the Prompt's content must be its position and this postfix, i.e. 1 + "_white.gif". |
indexListPostfixImage | STRING | .gif | false | Deprecated. FP not being used anymore. The name of each image on the Prompt's index must be its position and this postfix, i.e. 1 + "_white.gif". |
initialIndent | INTEGER | 0 | false | Deprecated. Indentation is not appended by Transforms anymore. Indicates the initial indentation of the HTML generated. |
lastIncFecthImage | STRING | arrow_end_inc_fetch_v.gif | false | Deprecated. FP not being used anymore. The name of the image for the last block in incremental fetching. |
lowerCornerImage | STRING | loginLowerLeftCorner.gif | false | Deprecated. FP not being used anymore. The image for the lower corner of the frame for multi-prompted reports. As of version 8.0, these formal parameters are not directly used by the application. They are still referenced by the PromptsClassicTransform.renderPromptsContainer(MarkupOutput) method |
multiplePromptCssFile | STRING | false | Specifies the css file to use if it's multiple prompt information that requires to be rendered. This css file will be used together with the one indicated on the cssFile formal parameter. |
|
nextIncFecthImage | STRING | arrow_right_inc_fetch_v.gif | false | Deprecated. FP not being used anymore. The name of the image for the next block in incremental fetching. |
orientation | INTEGER | 2 | false | Indicates the orientation the dialog to render will have. Usage: Possible values for this property and their meaning include: |
orientationsAllowed | INTEGER | 3 | false | Indicates the orientation modes allowed for the dialog to render. Usage: Possible values for this property and their meaning include: |
previousIncFecthImage | STRING | arrow_left_inc_fetch_v.gif | false | Deprecated. FP not being used anymore. The name of the image for the previous block in incremental fetching. |
promptLevelFlag | INTEGER | 3327 | false | |
promptQuestionlevelFlag | INTEGER | 4095 | false | |
renderForm | BOOLEAN | true | false | Indicates wheteher the transform will render its own form |
resizeLevel | INTEGER | 0 | false | Indicates whether the component can be resized vertically/horizontally or both or none.
Possible values are AbstractAppTransform.RESIZE_NONE , AbstractAppTransform.RESIZE_VERTICAL , AbstractAppTransform.RESIZE_HORIZONTAL ,
AbstractAppTransform.RESIZE_ALL |
scriptClass | STRING | false | Holds the name of the javaScript class (if any) to be associated with the component.
When the scriptClass is specified, a bone is registered on the page for this component.
A bone is the corresponding concept of a bean in Microstrategy's javascript environment. By default, thie methods returns an empty string. Transform which does have an associated bone needs to override this method. |
|
showExecuteAtBottom | INTEGER | 3 | false | Specifies whether or not to show an 'Execute' button at the bottom of the list of Prompts. This flag is used as int value. Possible values are defined in EnumPromptLevelFlags enumeration. Allowed Values:
|
showExecuteAtTop | INTEGER | 2 | false | Specifies whether or not to show an 'Execute' button at the top of the list of Prompts. This flag is used as int value. Possible values are defined in EnumPromptLevelFlags enumeration. Allowed Values:
|
showMatchCase | BOOLEAN | false | false | Deprecated. Specifies whether a match case checkbox is displayed at the end of a given search form within prompt question. Not all prompt types support searching for elements or objects, so it could be ignored. A match case checkbox is normally displayed next to this search section. This value is propagated to corresponding prompt transform(s), meaning that will affect all prompts in a given report. This flag is used as boolean value. |
showRequired | BOOLEAN | true | false | Specifies whether or not to show required message in prompt question title. Per default, all prompts defined as required, display a "Required" message at the end of the prompt title. This flag will overrule this layout requirement by not displaying this message even though prompt is required. This value is propagated to corresponding prompt transform(s), meaning that will affect all prompts in a given report. This flag is used as boolean value. |
showRequiredFirst | BOOLEAN | false | false | Deprecated. Specifies whether prompts defined as required will be rendered first or not. Applies only when prompts are displayed in one page. Prompts can be sorted by priority. Important: This FP is directly associated to a Project preference; this means that it can't be modified in StyleCatalog because it's a Transform property. This flag is used as boolean value. |
summaryImage | STRING | PromptSummary.gif | false | Deprecated. FP not being used anymore. The name of the image for displaying the summary item. |
type | STRING | false | This parameter is used when the output of this Transform generates a corresponding Microstrategy bone in the page, and it informs the javascript the type of bone it is. For example, action of a Toolbar will be applied to the "grid" bone (in the Report page), or the the rwb_viewer (in the document's page). Possible values for this property are bone ids, its usage depends on the page. |
|
upperCornerImage | STRING | loginUpperLeftCorner.gif | false | Deprecated. FP not being used anymore. The Image for the upper corner of the frame for multi-prompted reports. As of version 8.0, these formal parameters are not directly used by the application. They are still referenced by the PromptsClassicTransform.renderPromptsContainer(MarkupOutput) method |
useDHTML | BOOLEAN | true | false | Indicates whether to use DHTML on the output. If not set, the bean's OutputFormat() method will be used. |
width | STRING | false | Indicates the default width of the component. If this is not a resizable component, this
is the width used. If if it resizable, though, the user might change its width
using javascript and the value is saved in a preference; thereafter the Transform
will use this new value for this component. |